|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An instance of ICategory
is a handle representing a category
as defined by the extension point org.eclipse.ui.commands
.
The identifier of the handle is identifier of the category being
represented.
An instance of ICategory
can be obtained from an instance of
ICommandManager
for any identifier, whether or not a category
with that identifier defined in the plugin registry.
The handle-based nature of this API allows it to work well with runtime plugin activation and deactivation, which causes dynamic changes to the plugin registry, and therefore, potentially, dynamic changes to the set of category definitions.
This interface is not intended to be extended or implemented by clients.
EXPERIMENTAL
ICategoryListener
,
ICommandManager
Method Summary | |
void |
addCategoryListener(ICategoryListener categoryListener)
Registers an instance of ICategoryListener to listen for
changes to attributes of this instance. |
String |
getDescription()
Returns the description of the category represented by this handle, suitable for display to the user. |
String |
getId()
Returns the identifier of this handle. |
String |
getName()
Returns the name of the category represented by this handle, suitable for display to the user. |
boolean |
isDefined()
Returns whether or not the category represented by this handle is defined. |
void |
removeCategoryListener(ICategoryListener categoryListener)
Unregisters an instance of ICategoryListener listening
for changes to attributes of this instance. |
Methods inherited from interface java.lang.Comparable |
compareTo |
Method Detail |
public void addCategoryListener(ICategoryListener categoryListener)
ICategoryListener
to listen for
changes to attributes of this instance.
categoryListener
- the instance of ICategoryListener
to register.
Must not be null
. If an attempt is made to
register an instance of ICategoryListener
which is already registered with this instance, no operation
is performed.public String getDescription() throws NotDefinedException
Returns the description of the category represented by this handle, suitable for display to the user.
Notification is sent to all registered listeners if this attribute changes.
null
.
NotDefinedException
- if the category represented by this handle is not defined.public String getId()
null
.public String getName() throws NotDefinedException
Returns the name of the category represented by this handle, suitable for display to the user.
Notification is sent to all registered listeners if this attribute changes.
null
.
NotDefinedException
- if the category represented by this handle is not defined.public boolean isDefined()
Returns whether or not the category represented by this handle is defined.
Notification is sent to all registered listeners if this attribute changes.
true
, iff the category represented by this
handle is defined.public void removeCategoryListener(ICategoryListener categoryListener)
ICategoryListener
listening
for changes to attributes of this instance.
categoryListener
- the instance of ICategoryListener
to
unregister. Must not be null
. If an attempt
is made to unregister an instance of ICategoryListener
which is not already registered with this instance, no
operation is performed.
|
Eclipse Platform Pre-release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |